Business API

The WHATS'ON Business API opens up functionality to external systems. This allows you to build integrations with WHATS'ON, be it from a rights management system, a MAM, an ESB or any other system that needs information from or wants to push information towards WHATS'ON. test

The Business API is a REST-based API, which uses the JSON format to exchange data.

Types

The Business API contains a number of distinct APIs which allow interfacing with a certain module:

• As-run API
• Commercial integration API
• Company API
• Content API
• Copyright API
• Curation API
• File API
• Linear schedule API
• MAM API
• On-demand schedule API
• Person API
• Rights API
• Rights Out API
• Sport API
• Trailer API

Explorer

Each of these APIs has a formal specification defined in a Swagger/OpenAPI definition. This definition describes the available calls of the API in detail with all available endpoints and fields. With this approach, there is support for automated documentation, code generation, and test case generation. See https://www.openapis.org and https://swagger.io for more information.

The generated documentation can be consulted in the explorer for each API.

Note that the documentation available via the API Explorers is representing the functionality of the most recent base version of WHATS'ON. In order to get the Swagger/Open API definition of your own version of WHATS'ON including any customizations, each Business API has a GET /api call: e.g. GET http://localhost:8888/content/v1/api.

Knowledge base

Here you can consult what has recently changed to the documentation.